home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / wdiff004.lha / wdiff-0.04 / README < prev    next >
Text File  |  1992-12-23  |  6KB  |  153 lines
  1. README file for GNU wdiff, last updated December 21, 1992.
  2. Copyright (C) 1992 Free Software Foundation, Inc.
  3. Written by Francois Pinard <pinard@iro.umontreal.ca>.
  4.  
  5. Subject: Release of GNU wdiff, version 0.04
  6. Subject: GNU wdiff 0.0 - Patch 4, brings 0.03 to 0.04
  7.  
  8. The program wdiff, version 0.04, is now available on prep.ai.mit.edu,
  9. in directory pub/gnu, as file wdiff-0.04.tar.Z.  All reported bugs
  10. have been fixed.  Some bugs surely remain.  Your feedback will help me
  11. to make wdiff better and more portable.  Please report any wdiff
  12. problems to me or to bug-gnu-utils@prep.ai.mit.edu.  Thanks to all
  13. those who contributed comments or suggestions.
  14.  
  15. Read the file NEWS for an inventory of user visible changes, and file
  16. ChangeLog for a detailed list of all changes.  You will find below a
  17. description of wdiff, how to get its documentation, how to apply the
  18. current patch, a few installation notes you should read and, finally,
  19. the answer to some frequently asked questions.
  20.  
  21. Installation has been simplified.  Flex is not anymore required for
  22. non ANSI-C compilers.  wdiff uses the first found of gnudiff, diffgnu,
  23. gdiff or diff.  Some other portability problems have been alleviated.
  24.  
  25. James Ganong <jeg@ced.berkeley.edu> wrote collatew.el, generalizing
  26. the Emacs LISP compare-windows function in the spirit of wdiff;
  27. however, his package is not part of the wdiff distribution.  Email to
  28. James or me for a copy.
  29.  
  30. Colin Brough <cmb@epcc.ed.ac.uk> contributed a man page, describing
  31. wdiff at level 0.04.  The man page will be distributed and installed
  32. along with wdiff as long as Colin will want to maintain it.
  33.  
  34. .------------------.
  35. |  What is wdiff?  |
  36. `------------------'
  37.  
  38. The program wdiff is a front end to diff for comparing files on a word
  39. per word basis.  A word is anything between whitespace.  This program
  40. is particularily useful for comparing two texts in which a few words
  41. have been changed and for which paragraphs have been refilled.  wdiff
  42. is free software.  See files COPYING and COPYING.LIB for copying
  43. conditions.
  44.  
  45. This program does not require termcap, but takes advantage of it.  If
  46. your system does not have termcap, you might feel like getting and
  47. installing GNU termcap first.  Grab termcap-1.1.tar.Z in /pub/gnu from
  48. prep.ai.mit.edu.
  49.  
  50. .-----------------.
  51. |  Documentation  |
  52. `-----------------'
  53.  
  54. Calling just wdiff, without arguments, will summarize its usage.  The
  55. true documentation is in Texinfo format.  You can look at the file
  56. wdiff.info using any ASCII editor, or even print the file as is.  You
  57. may browse it from inside GNU Emacs by typing:
  58.  
  59.     C-u M-x info RET wdiff.info RET
  60.  
  61. or, using the standalone Info reader, through the command:
  62.  
  63.     info -f wdiff.info
  64.  
  65. If you have TeX, execute the command:
  66.  
  67.     tex wdiff.texi
  68.  
  69. then process and print wdiff.dvi the usual way.  You can find makeinfo
  70. and the standalone info reader in file texinfo-2.15.tar.Z in /pub/gnu
  71. from prep.ai.mit.edu: just unpack it and look into the C subdirectory.
  72.  
  73. .----------------------.
  74. |  Applying the Patch  |
  75. `----------------------'
  76.  
  77. This section is for you only if you received this as an introduction
  78. to a patch in diff format.  Apply this patch to wdiff-0.03 to get
  79. wdiff-0.04.  It is a unified diff, you can apply it using a recent
  80. version of the patch program, like patch-2.0.12g8.tar.Z in /pub/gnu
  81. from prep.ai.mit.edu.  Given you have it, first save this article in
  82. file THIS_ARTICLE, then execute the following commands:
  83.  
  84.     cd wdiff-0.03
  85.     patch < THIS_ARTICLE
  86.  
  87. If you just patched wdiff, or if you received it whole in shar format,
  88. the time stamps might be improper.  You might somewhat alleviate the
  89. problem with the two following commands:
  90.  
  91.     touch configure    <- if you forget this, you need autoconf!
  92.     touch wdiff.info   <- if you forget this, you need makeinfo!
  93.  
  94. .----------------------.
  95. |  Installation notes  |
  96. `----------------------'
  97.  
  98. See the file INSTALL for building and installation instructions.
  99. However, beware of these peculiarities:
  100.  
  101. * There is a simple minded change bars producer in wdiff, which is not
  102. installed by default, nor documented.  If you nevertheles want it, one
  103. way to get it is requesting, at the final installation step:
  104.  
  105.     make install PROGS='wdiff cbars'
  106.  
  107. * If you have both more and less, you prefer more to less, your PAGER
  108. environment variable does not tell about more, then prefix the call to
  109. configure with your pager selection, as in:
  110.  
  111.     PAGER=more sh configure
  112.  
  113. * If you have termcap emulation routines in libcurses.a and you do not
  114. have libtermcap.a, and until I find a way to do better, please use:
  115.  
  116.     LIBS=-lcurses sh configure
  117.  
  118. .------------------------------.
  119. |  Frequently Asked Questions  |
  120. `------------------------------'
  121.  
  122. Q: How is wdiff different from diff -w?
  123.  
  124. wdiff finds word differences, ignoring spaces, tabs and newlines,
  125. while diff -w finds *line* differences, ignoring spaces and tabs.
  126. Also, each program uses its own output format.
  127.  
  128. Q: How about spiff by Dan Nachbar <nachbar@bellcore.com>?
  129.  
  130. spiff is far more general than wdiff.  On the other end, wdiff is a
  131. lot faster, needs almost no memory, and can afford handling big files
  132. in reasonnable time.  Despite its lack of generality, wdiff does one
  133. of the most usual jobs, so it is quite useful after all.  I might try
  134. retrofitting some of spiff features into wdiff, but not on short term.
  135.  
  136. Q: How much memory wdiff exactly needs?
  137.  
  138. wdiff uses a fixed amount of memory.  Long lines or long files are no
  139. handicap.  All the true work is done by diff under the scene, and diff
  140. needs memory itself.  GNU diff swallows both files in memory first.
  141.  
  142. Q: Why not simply apply diff to files split one word per line?
  143.  
  144. You like the way wdiff formats its output.  And it's speedier too.
  145.  
  146. Q: Why calling an external diff?  Could not diff be built in wdiff?
  147.  
  148. It's not fruitful to rewrite another diff.  I'd rather see wdiff
  149. integrated in GNU diff than the other way around.  This might come.
  150. When wdiff will have matured enough, it *might* be integrated into GNU
  151. diff distribution, or in GNU diff itself.
  152.  
  153.